<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>MiXiM: D:/Projects/MiXiM/extsrc/mixim/src/modules/transport/Aggregation.h Source File</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">MiXiM
   &#160;<span id="projectnumber">2.3</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('a00489.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">Aggregation.h</div>  </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/***************************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> * file:        Aggregation.h</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * author:      Jerome Rousselot &lt;jerome.rousselot@csem.ch&gt;</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * copyright:   (C) 2010 CSEM SA, Neuchatel, Switzerland.</span>
<a name="l00007"></a>00007 <span class="comment"> *</span>
<a name="l00008"></a>00008 <span class="comment"> *              This program is free software; you can redistribute it</span>
<a name="l00009"></a>00009 <span class="comment"> *              and/or modify it under the terms of the GNU General Public</span>
<a name="l00010"></a>00010 <span class="comment"> *              License as published by the Free Software Foundation; either</span>
<a name="l00011"></a>00011 <span class="comment"> *              version 2 of the License, or (at your option) any later</span>
<a name="l00012"></a>00012 <span class="comment"> *              version.</span>
<a name="l00013"></a>00013 <span class="comment"> *              For further information see file COPYING</span>
<a name="l00014"></a>00014 <span class="comment"> *              in the top level directory</span>
<a name="l00015"></a>00015 <span class="comment"> ***************************************************************************</span>
<a name="l00016"></a>00016 <span class="comment"> * description: this class aggregates the packets received from the application</span>
<a name="l00017"></a>00017 <span class="comment"> * layer and separates packet emissions by a time InterPacketDelay.</span>
<a name="l00018"></a>00018 <span class="comment"> ***************************************************************************/</span>
<a name="l00019"></a>00019 
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef AGGREGATION_H_</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define AGGREGATION_H_</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00023"></a>00023 <span class="preprocessor">#include &lt;omnetpp.h&gt;</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include &lt;map&gt;</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;list&gt;</span>
<a name="l00026"></a>00026 
<a name="l00027"></a>00027 <span class="preprocessor">#include &quot;MiXiMDefs.h&quot;</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include &quot;BaseLayer.h&quot;</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include &quot;SimpleAddress.h&quot;</span>
<a name="l00030"></a>00030 
<a name="l00031"></a>00031 <span class="keyword">class </span>ApplPkt;
<a name="l00032"></a>00032 
<a name="l00038"></a><a class="code" href="a00005.html">00038</a> <span class="keyword">class </span>MIXIM_API <a class="code" href="a00005.html" title="this class aggregates the packets received from the application layer and separates packet emissions ...">Aggregation</a>: <span class="keyword">public</span> <a class="code" href="a00025.html" title="A very simple layer template.">BaseLayer</a> {
<a name="l00039"></a>00039     <span class="keyword">private</span>:
<a name="l00042"></a>00042         <a class="code" href="a00005.html" title="this class aggregates the packets received from the application layer and separates packet emissions ...">Aggregation</a>(<span class="keyword">const</span> <a class="code" href="a00005.html" title="this class aggregates the packets received from the application layer and separates packet emissions ...">Aggregation</a>&amp;);
<a name="l00045"></a>00045         <a class="code" href="a00005.html" title="this class aggregates the packets received from the application layer and separates packet emissions ...">Aggregation</a>&amp; <a class="code" href="a00025.html#a063fda133f5220b9db525cd32c6d683b" title="Assignment operator is not allowed.">operator=</a>(<span class="keyword">const</span> <a class="code" href="a00005.html" title="this class aggregates the packets received from the application layer and separates packet emissions ...">Aggregation</a>&amp;);
<a name="l00046"></a>00046 
<a name="l00047"></a>00047     <span class="keyword">public</span>:
<a name="l00048"></a>00048         <a class="code" href="a00005.html" title="this class aggregates the packets received from the application layer and separates packet emissions ...">Aggregation</a>();
<a name="l00049"></a>00049         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a00025.html#a70f5ea30a9980d57b8384faed29ec3eb" title="Initialization of the module and some variables.">initialize</a>(<span class="keywordtype">int</span>);
<a name="l00050"></a>00050         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a00025.html#a5ab11502dbeeea89693d29841376a2f7" title="Called when the simulation has finished.">finish</a>();
<a name="l00051"></a>00051     <span class="keyword">protected</span>:
<a name="l00052"></a>00052         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a00025.html#a87d7e1e5aa73216f07e35d7be4358924" title="Handle self messages such as timer...">handleSelfMsg</a>(cMessage* msg);
<a name="l00053"></a>00053         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a00025.html#a8c0fcfb2e806357a65d5bdb1c338627b" title="Handle messages from upper layer.">handleUpperMsg</a>(cMessage *msg);
<a name="l00054"></a>00054         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a00025.html#a5ca2278405070baa474dfbf059930247" title="Handle messages from lower layer.">handleLowerMsg</a>(cMessage *msg);
<a name="l00055"></a>00055         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a00025.html#aa37925527fae20a5de1a755103056219" title="Handle control messages from lower layer.">handleLowerControl</a>(cMessage *msg);
<a name="l00056"></a>00056         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a00025.html#ab412568faae75040194e01d5e541dd67" title="Handle control messages from upper layer.">handleUpperControl</a>(cMessage *msg);
<a name="l00057"></a>00057     <span class="keyword">private</span>:
<a name="l00058"></a>00058         <span class="comment">// this type is used to store, for a network destination, the time</span>
<a name="l00059"></a>00059         <span class="comment">// at which a packet was last sent to it, and the packets currently</span>
<a name="l00060"></a>00060         <span class="comment">// queued for aggregation.</span>
<a name="l00061"></a>00061         <span class="keyword">typedef</span> std::pair&lt;simtime_t, std::list&lt;ApplPkt*&gt; &gt; destInfo;
<a name="l00062"></a>00062 
<a name="l00063"></a>00063         <span class="comment">// this map associates to each known netwok address</span>
<a name="l00064"></a>00064         <span class="comment">// the time at which a packet was last sent to it, and a vector</span>
<a name="l00065"></a>00065         <span class="comment">// of packets currently queued for it (waiting aggregation).</span>
<a name="l00066"></a>00066         std::map&lt;LAddress::L3Type, destInfo&gt; destInfos;
<a name="l00067"></a>00067 
<a name="l00068"></a>00068         <span class="comment">// This message is used as a timer to perform aggregation</span>
<a name="l00069"></a>00069         cMessage* aggregationTimer;
<a name="l00070"></a>00070 
<a name="l00071"></a>00071         <span class="comment">// This is the minimum time between two transmissions to a same network destination</span>
<a name="l00072"></a>00072         simtime_t interPacketDelay;
<a name="l00073"></a>00073 
<a name="l00074"></a>00074         <span class="comment">// maximum number of packets to aggregate into a single unit.</span>
<a name="l00075"></a>00075         <span class="keywordtype">int</span> nbMaxPacketsPerAggregation;
<a name="l00076"></a>00076 
<a name="l00077"></a>00077         <span class="comment">// returns true if we can send now to this destination</span>
<a name="l00078"></a>00078         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isOkToSendNow(<span class="keyword">const</span> <a class="code" href="a00117.html#ad85cd9e8d9e7e9cd5d02dd740c4a12a4" title="Type definition for a L3 (Network) address.">LAddress::L3Type</a>&amp; dest);
<a name="l00079"></a>00079 
<a name="l00080"></a>00080         <span class="comment">// sends aggregated packets to destination now</span>
<a name="l00081"></a>00081         <span class="keywordtype">void</span> sendAggregatedPacketNow(<span class="keyword">const</span> <a class="code" href="a00117.html#ad85cd9e8d9e7e9cd5d02dd740c4a12a4" title="Type definition for a L3 (Network) address.">LAddress::L3Type</a>&amp; dest);
<a name="l00082"></a>00082 
<a name="l00083"></a>00083         <span class="comment">// counters</span>
<a name="l00084"></a>00084         <span class="keywordtype">long</span> nbAggrPktSentDown;
<a name="l00085"></a>00085         <span class="keywordtype">long</span> nbAggrPktReceived;
<a name="l00086"></a>00086 };
<a name="l00087"></a>00087 
<a name="l00088"></a>00088 <span class="preprocessor">#endif </span><span class="comment">/* AGGREGATION_H_ */</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>Aggregation.h</b>      </li>

    <li class="footer">Generated on Tue Mar 5 2013 21:26:30 for MiXiM by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
   </ul>
 </div>


</body>
</html>
